<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>GFileEnumerator</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
<link rel="start" href="index.html" title="GIO Reference Manual">
<link rel="up" href="file_ops.html" title="File Operations">
<link rel="prev" href="GFileInfo.html" title="GFileInfo">
<link rel="next" href="GMountOperation.html" title="GMountOperation">
<meta name="generator" content="GTK-Doc V1.9 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="pt01.html" title="Part&#160;I.&#160;GIO Overview">
<link rel="chapter" href="ch01.html" title="Introduction">
<link rel="chapter" href="ch02.html" title="Compiling GIO applications">
<link rel="chapter" href="ch03.html" title="Running GIO applications">
<link rel="chapter" href="gio-extension-points.html" title="Extending GIO">
<link rel="part" href="pt02.html" title="Part&#160;II.&#160;API Reference">
<link rel="chapter" href="file_ops.html" title="File Operations">
<link rel="chapter" href="file_mon.html" title="File System Monitoring">
<link rel="chapter" href="async.html" title="Asynchronous I/O">
<link rel="chapter" href="streaming.html" title="Streaming I/O">
<link rel="chapter" href="types.html" title="File types and applications">
<link rel="chapter" href="volume_mon.html" title="Volumes and Drives">
<link rel="chapter" href="icons.html" title="Icons">
<link rel="chapter" href="utils.html" title="Utilities">
<link rel="chapter" href="extending.html" title="Extending GIO">
<link rel="part" href="migrating.html" title="Part&#160;III.&#160;Migrating to GIO">
<link rel="chapter" href="ch14.html" title="Migrating from POSIX to GIO">
<link rel="chapter" href="ch15.html" title="Migrating from GnomeVFS to GIO">
<link rel="chapter" href="gio-hierarchy.html" title="Object Hierarchy">
<link rel="index" href="ix01.html" title="Index">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="GFileInfo.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="file_ops.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GIO Reference Manual</th>
<td><a accesskey="n" href="GMountOperation.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2801633" class="shortcut">Top</a>
                  &#160;|&#160;
                  <a href="#id2786896" class="shortcut">Description</a>
                  &#160;|&#160;
                  <a href="#id2786872" class="shortcut">Object Hierarchy</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="GFileEnumerator"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2801633"></a><span class="refentrytitle">GFileEnumerator</span>
</h2>
<p>GFileEnumerator &#8212; Enumerated Files Routines</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">

#include &lt;gio/gio.h&gt;


                    <a class="link" href="GFileEnumerator.html#GFileEnumerator-struct">GFileEnumerator</a>;
<a class="link" href="GFileInfo.html" title="GFileInfo">GFileInfo</a>*          <a class="link" href="GFileEnumerator.html#g-file-enumerator-next-file">g_file_enumerator_next_file</a>         (<a class="link" href="GFileEnumerator.html" title="GFileEnumerator">GFileEnumerator</a> *enumerator,
                                                         <a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable,
                                                         <a
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
>GError</a> **error);
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a>            <a class="link" href="GFileEnumerator.html#g-file-enumerator-close">g_file_enumerator_close</a>             (<a class="link" href="GFileEnumerator.html" title="GFileEnumerator">GFileEnumerator</a> *enumerator,
                                                         <a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable,
                                                         <a
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
>GError</a> **error);
void                <a class="link" href="GFileEnumerator.html#g-file-enumerator-next-files-async">g_file_enumerator_next_files_async</a>  (<a class="link" href="GFileEnumerator.html" title="GFileEnumerator">GFileEnumerator</a> *enumerator,
                                                         int num_files,
                                                         int io_priority,
                                                         <a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable,
                                                         <a class="link" href="GAsyncResult.html#GAsyncReadyCallback">GAsyncReadyCallback</a> callback,
                                                         <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data);
<a
href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"
>GList</a>*              <a class="link" href="GFileEnumerator.html#g-file-enumerator-next-files-finish">g_file_enumerator_next_files_finish</a> (<a class="link" href="GFileEnumerator.html" title="GFileEnumerator">GFileEnumerator</a> *enumerator,
                                                         <a class="link" href="GAsyncResult.html" title="GAsyncResult">GAsyncResult</a> *result,
                                                         <a
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
>GError</a> **error);
void                <a class="link" href="GFileEnumerator.html#g-file-enumerator-close-async">g_file_enumerator_close_async</a>       (<a class="link" href="GFileEnumerator.html" title="GFileEnumerator">GFileEnumerator</a> *enumerator,
                                                         int io_priority,
                                                         <a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable,
                                                         <a class="link" href="GAsyncResult.html#GAsyncReadyCallback">GAsyncReadyCallback</a> callback,
                                                         <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data);
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a>            <a class="link" href="GFileEnumerator.html#g-file-enumerator-close-finish">g_file_enumerator_close_finish</a>      (<a class="link" href="GFileEnumerator.html" title="GFileEnumerator">GFileEnumerator</a> *enumerator,
                                                         <a class="link" href="GAsyncResult.html" title="GAsyncResult">GAsyncResult</a> *result,
                                                         <a
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
>GError</a> **error);
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a>            <a class="link" href="GFileEnumerator.html#g-file-enumerator-is-closed">g_file_enumerator_is_closed</a>         (<a class="link" href="GFileEnumerator.html" title="GFileEnumerator">GFileEnumerator</a> *enumerator);
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a>            <a class="link" href="GFileEnumerator.html#g-file-enumerator-has-pending">g_file_enumerator_has_pending</a>       (<a class="link" href="GFileEnumerator.html" title="GFileEnumerator">GFileEnumerator</a> *enumerator);
void                <a class="link" href="GFileEnumerator.html#g-file-enumerator-set-pending">g_file_enumerator_set_pending</a>       (<a class="link" href="GFileEnumerator.html" title="GFileEnumerator">GFileEnumerator</a> *enumerator,
                                                         <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> pending);


</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2786872"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">

  <a
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"
>GObject</a>
   +----GFileEnumerator
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2786896"></a><h2>Description</h2>
<p>
<a class="link" href="GFileEnumerator.html" title="GFileEnumerator"><span class="type">GFileEnumerator</span></a> allows you to operate on a set of <a class="link" href="GFile.html" title="GFile"><span class="type">GFile</span></a>s, 
returning a <a class="link" href="GFileInfo.html" title="GFileInfo"><span class="type">GFileInfo</span></a> structure for each file enumerated (e.g. 
<a class="link" href="GFile.html#g-file-enumerate-children"><code class="function">g_file_enumerate_children()</code></a> will return a <a class="link" href="GFileEnumerator.html" title="GFileEnumerator"><span class="type">GFileEnumerator</span></a> for each 
of the children within a directory).
</p>
<p>
To get the next file's information from a <a class="link" href="GFileEnumerator.html" title="GFileEnumerator"><span class="type">GFileEnumerator</span></a>, use 
<a class="link" href="GFileEnumerator.html#g-file-enumerator-next-file"><code class="function">g_file_enumerator_next_file()</code></a> or its asynchronous version, 
<code class="function">g_file_enumerator_next_file_async()</code>. Note that the asynchronous 
version will return a list of <a class="link" href="GFileInfo.html" title="GFileInfo"><span class="type">GFileInfo</span></a>s, whereas the 
synchronous will only return the next file in the enumerator.
</p>
<p>
To close a <a class="link" href="GFileEnumerator.html" title="GFileEnumerator"><span class="type">GFileEnumerator</span></a>, use <a class="link" href="GFileEnumerator.html#g-file-enumerator-close"><code class="function">g_file_enumerator_close()</code></a>, or 
its asynchronous version, <a class="link" href="GFileEnumerator.html#g-file-enumerator-close-async"><code class="function">g_file_enumerator_close_async()</code></a>. Once 
a <a class="link" href="GFileEnumerator.html" title="GFileEnumerator"><span class="type">GFileEnumerator</span></a> is closed, no further actions may be performed 
on it, and it should be freed with <a
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref"
><code class="function">g_object_unref()</code></a>.</p>
<p>

</p>
</div>
<div class="refsect1" lang="en">
<a name="id2805949"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2805960"></a><h3>
<a name="GFileEnumerator-struct"></a>GFileEnumerator</h3>
<a class="indexterm" name="id2805971"></a><pre class="programlisting">typedef struct _GFileEnumerator GFileEnumerator;</pre>
<p>
A per matched file iterator.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2766280"></a><h3>
<a name="g-file-enumerator-next-file"></a>g_file_enumerator_next_file ()</h3>
<a class="indexterm" name="id2766291"></a><pre class="programlisting"><a class="link" href="GFileInfo.html" title="GFileInfo">GFileInfo</a>*          g_file_enumerator_next_file         (<a class="link" href="GFileEnumerator.html" title="GFileEnumerator">GFileEnumerator</a> *enumerator,
                                                         <a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable,
                                                         <a
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
>GError</a> **error);</pre>
<p>
Returns information for the next file in the enumerated object.
Will block until the information is available. The <a class="link" href="GFileInfo.html" title="GFileInfo"><span class="type">GFileInfo</span></a> 
returned from this function will contain attributes that match the 
attribute string that was passed when the <a class="link" href="GFileEnumerator.html" title="GFileEnumerator"><span class="type">GFileEnumerator</span></a> was created.
</p>
<p>
On error, returns <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a> and sets <em class="parameter"><code>error</code></em> to the error. If the
enumerator is at the end, <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a> will be returned and <em class="parameter"><code>error</code></em> will
be unset.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>enumerator</code></em>&#160;:</span></p></td>
<td> a <a class="link" href="GFileEnumerator.html" title="GFileEnumerator"><span class="type">GFileEnumerator</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em>&#160;:</span></p></td>
<td> optional <a class="link" href="GCancellable.html" title="GCancellable"><span class="type">GCancellable</span></a> object, <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a> to ignore.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em>&#160;:</span></p></td>
<td> location to store the error occuring, or <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a> to ignore
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> A <a class="link" href="GFileInfo.html" title="GFileInfo"><span class="type">GFileInfo</span></a> or <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a> on error or end of enumerator
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2766497"></a><h3>
<a name="g-file-enumerator-close"></a>g_file_enumerator_close ()</h3>
<a class="indexterm" name="id2766508"></a><pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a>            g_file_enumerator_close             (<a class="link" href="GFileEnumerator.html" title="GFileEnumerator">GFileEnumerator</a> *enumerator,
                                                         <a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable,
                                                         <a
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
>GError</a> **error);</pre>
<p>
Releases all resources used by this enumerator, making the
enumerator return <a class="link" href="gio-GIOError.html#G-IO-ERROR-CLOSED:CAPS"><code class="literal">G_IO_ERROR_CLOSED</code></a> on all calls.
</p>
<p>
This will be automatically called when the last reference
is dropped, but you might want to call this function to make 
sure resources are released as early as possible.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>enumerator</code></em>&#160;:</span></p></td>
<td> a <a class="link" href="GFileEnumerator.html" title="GFileEnumerator"><span class="type">GFileEnumerator</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em>&#160;:</span></p></td>
<td> optional <a class="link" href="GCancellable.html" title="GCancellable"><span class="type">GCancellable</span></a> object, <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a> to ignore. 
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em>&#160;:</span></p></td>
<td> location to store the error occuring, or <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a> to ignore
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
><span class="type">TRUE</span></a> on success or <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
><span class="type">FALSE</span></a> on error.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2766943"></a><h3>
<a name="g-file-enumerator-next-files-async"></a>g_file_enumerator_next_files_async ()</h3>
<a class="indexterm" name="id2766956"></a><pre class="programlisting">void                g_file_enumerator_next_files_async  (<a class="link" href="GFileEnumerator.html" title="GFileEnumerator">GFileEnumerator</a> *enumerator,
                                                         int num_files,
                                                         int io_priority,
                                                         <a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable,
                                                         <a class="link" href="GAsyncResult.html#GAsyncReadyCallback">GAsyncReadyCallback</a> callback,
                                                         <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data);</pre>
<p>
Request information for a number of files from the enumerator asynchronously.
When all i/o for the operation is finished the <em class="parameter"><code>callback</code></em> will be called with
the requested information. 
</p>
<p>
The callback can be called with less than <em class="parameter"><code>num_files</code></em> files in case of error
or at the end of the enumerator. In case of a partial error the callback will
be called with any succeeding items and no error, and on the next request the
error will be reported. If a request is cancelled the callback will be called
with <a class="link" href="gio-GIOError.html#G-IO-ERROR-CANCELLED:CAPS"><code class="literal">G_IO_ERROR_CANCELLED</code></a>.
</p>
<p>
During an async request no other sync and async calls are allowed, and will
result in <a class="link" href="gio-GIOError.html#G-IO-ERROR-PENDING:CAPS"><code class="literal">G_IO_ERROR_PENDING</code></a> errors. 
</p>
<p>
Any outstanding i/o request with higher priority (lower numerical value) will
be executed before an outstanding request with lower priority. Default
priority is <a
href="/usr/share/gtk-doc/html/glib/glib-The-Main-Event-Loop.html#G-PRIORITY-DEFAULT:CAPS"
><code class="literal">G_PRIORITY_DEFAULT</code></a>.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>enumerator</code></em>&#160;:</span></p></td>
<td> a <a class="link" href="GFileEnumerator.html" title="GFileEnumerator"><span class="type">GFileEnumerator</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>num_files</code></em>&#160;:</span></p></td>
<td> the number of file info objects to request
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>io_priority</code></em>&#160;:</span></p></td>
<td> the io priority 
    of the request. 
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em>&#160;:</span></p></td>
<td> optional <a class="link" href="GCancellable.html" title="GCancellable"><span class="type">GCancellable</span></a> object, <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a> to ignore.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>callback</code></em>&#160;:</span></p></td>
<td> a <a class="link" href="GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> to call when the request is satisfied
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></p></td>
<td> the data to pass to callback function
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2767212"></a><h3>
<a name="g-file-enumerator-next-files-finish"></a>g_file_enumerator_next_files_finish ()</h3>
<a class="indexterm" name="id2767225"></a><pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"
>GList</a>*              g_file_enumerator_next_files_finish (<a class="link" href="GFileEnumerator.html" title="GFileEnumerator">GFileEnumerator</a> *enumerator,
                                                         <a class="link" href="GAsyncResult.html" title="GAsyncResult">GAsyncResult</a> *result,
                                                         <a
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
>GError</a> **error);</pre>
<p>
Finishes the asynchronous operation started with <a class="link" href="GFileEnumerator.html#g-file-enumerator-next-files-async"><code class="function">g_file_enumerator_next_files_async()</code></a>.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>enumerator</code></em>&#160;:</span></p></td>
<td> a <a class="link" href="GFileEnumerator.html" title="GFileEnumerator"><span class="type">GFileEnumerator</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>result</code></em>&#160;:</span></p></td>
<td> a <a class="link" href="GAsyncResult.html" title="GAsyncResult"><span class="type">GAsyncResult</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em>&#160;:</span></p></td>
<td> a <a
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
><span class="type">GError</span></a> location to store the error occuring, or <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a> to 
ignore.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> a <a
href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"
><span class="type">GList</span></a> of <a class="link" href="GFileInfo.html" title="GFileInfo"><span class="type">GFileInfo</span></a>s. You must free the list with 
    <a
href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#g-list-free"
><code class="function">g_list_free()</code></a> and unref the infos with g_object_unref when you're 
    done with them.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2767395"></a><h3>
<a name="g-file-enumerator-close-async"></a>g_file_enumerator_close_async ()</h3>
<a class="indexterm" name="id2767408"></a><pre class="programlisting">void                g_file_enumerator_close_async       (<a class="link" href="GFileEnumerator.html" title="GFileEnumerator">GFileEnumerator</a> *enumerator,
                                                         int io_priority,
                                                         <a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable,
                                                         <a class="link" href="GAsyncResult.html#GAsyncReadyCallback">GAsyncReadyCallback</a> callback,
                                                         <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data);</pre>
<p>
Asynchronously closes the file enumerator. 
</p>
<p>
If <em class="parameter"><code>cancellable</code></em> is not <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>, then the operation can be cancelled by
triggering the cancellable object from another thread. If the operation
was cancelled, the error <a class="link" href="gio-GIOError.html#G-IO-ERROR-CANCELLED:CAPS"><code class="literal">G_IO_ERROR_CANCELLED</code></a> will be returned in 
<a class="link" href="GFileEnumerator.html#g-file-enumerator-close-finish"><code class="function">g_file_enumerator_close_finish()</code></a>.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>enumerator</code></em>&#160;:</span></p></td>
<td> a <a class="link" href="GFileEnumerator.html" title="GFileEnumerator"><span class="type">GFileEnumerator</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>io_priority</code></em>&#160;:</span></p></td>
<td> the <a class="link" href="gio-GIOScheduler.html#io-priority">I/O priority</a> 
    of the request.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em>&#160;:</span></p></td>
<td> optional <a class="link" href="GCancellable.html" title="GCancellable"><span class="type">GCancellable</span></a> object, <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a> to ignore. 
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>callback</code></em>&#160;:</span></p></td>
<td> a <a class="link" href="GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> to call when the request is satisfied
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></p></td>
<td> the data to pass to callback function
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2795927"></a><h3>
<a name="g-file-enumerator-close-finish"></a>g_file_enumerator_close_finish ()</h3>
<a class="indexterm" name="id2795940"></a><pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a>            g_file_enumerator_close_finish      (<a class="link" href="GFileEnumerator.html" title="GFileEnumerator">GFileEnumerator</a> *enumerator,
                                                         <a class="link" href="GAsyncResult.html" title="GAsyncResult">GAsyncResult</a> *result,
                                                         <a
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
>GError</a> **error);</pre>
<p>
Finishes closing a file enumerator, started from <a class="link" href="GFileEnumerator.html#g-file-enumerator-close-async"><code class="function">g_file_enumerator_close_async()</code></a>.
</p>
<p>
If the file enumerator was already closed when <a class="link" href="GFileEnumerator.html#g-file-enumerator-close-async"><code class="function">g_file_enumerator_close_async()</code></a> 
was called, then this function will report <a class="link" href="gio-GIOError.html#G-IO-ERROR-CLOSED:CAPS"><code class="literal">G_IO_ERROR_CLOSED</code></a> in <em class="parameter"><code>error</code></em>, and 
return <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
><code class="literal">FALSE</code></a>. If the file enumerator had pending operation when the close 
operation was started, then this function will report <a class="link" href="gio-GIOError.html#G-IO-ERROR-PENDING:CAPS"><code class="literal">G_IO_ERROR_PENDING</code></a>, and
return <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
><code class="literal">FALSE</code></a>.  If <em class="parameter"><code>cancellable</code></em> was not <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>, then the operation may have been 
cancelled by triggering the cancellable object from another thread. If the operation
was cancelled, the error <a class="link" href="gio-GIOError.html#G-IO-ERROR-CANCELLED:CAPS"><code class="literal">G_IO_ERROR_CANCELLED</code></a> will be set, and <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
><code class="literal">FALSE</code></a> will be 
returned.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>enumerator</code></em>&#160;:</span></p></td>
<td> a <a class="link" href="GFileEnumerator.html" title="GFileEnumerator"><span class="type">GFileEnumerator</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>result</code></em>&#160;:</span></p></td>
<td> a <a class="link" href="GAsyncResult.html" title="GAsyncResult"><span class="type">GAsyncResult</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em>&#160;:</span></p></td>
<td> a <a
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
><span class="type">GError</span></a> location to store the error occuring, or <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a> to 
ignore.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> if the close operation has finished successfully.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2796193"></a><h3>
<a name="g-file-enumerator-is-closed"></a>g_file_enumerator_is_closed ()</h3>
<a class="indexterm" name="id2796204"></a><pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a>            g_file_enumerator_is_closed         (<a class="link" href="GFileEnumerator.html" title="GFileEnumerator">GFileEnumerator</a> *enumerator);</pre>
<p>
Checks if the file enumerator has been closed.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>enumerator</code></em>&#160;:</span></p></td>
<td> a <a class="link" href="GFileEnumerator.html" title="GFileEnumerator"><span class="type">GFileEnumerator</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> if the <em class="parameter"><code>enumerator</code></em> is closed.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2796288"></a><h3>
<a name="g-file-enumerator-has-pending"></a>g_file_enumerator_has_pending ()</h3>
<a class="indexterm" name="id2796302"></a><pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a>            g_file_enumerator_has_pending       (<a class="link" href="GFileEnumerator.html" title="GFileEnumerator">GFileEnumerator</a> *enumerator);</pre>
<p>
Checks if the file enumerator has pending operations.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>enumerator</code></em>&#160;:</span></p></td>
<td> a <a class="link" href="GFileEnumerator.html" title="GFileEnumerator"><span class="type">GFileEnumerator</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> if the <em class="parameter"><code>enumerator</code></em> has pending operations.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2796386"></a><h3>
<a name="g-file-enumerator-set-pending"></a>g_file_enumerator_set_pending ()</h3>
<a class="indexterm" name="id2796399"></a><pre class="programlisting">void                g_file_enumerator_set_pending       (<a class="link" href="GFileEnumerator.html" title="GFileEnumerator">GFileEnumerator</a> *enumerator,
                                                         <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> pending);</pre>
<p>
Sets the file enumerator as having pending operations.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>enumerator</code></em>&#160;:</span></p></td>
<td> a <a class="link" href="GFileEnumerator.html" title="GFileEnumerator"><span class="type">GFileEnumerator</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>pending</code></em>&#160;:</span></p></td>
<td> a boolean value.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2796480"></a><div class="refsect2" lang="en"><a name="id2796481"></a></div>
<hr>
<div class="refsect2" lang="en"><a name="id2796482"></a></div>
</div>
</div>
</body>
</html>
